MV_CC_SetEnumValueByString

MV_CC_SetEnumValueByString

Set the value of camera Enum type node.

API Definition

int MV_CC_SetEnumValueByString(
  void         *handle,
  const char   *strKey,
  const char   *sValue
);

Parameters

handle

[IN] Device handle, which is returned by MV_CC_CreateHandle or MV_CC_CreateHandleWithoutLog.

strKey

[IN] Node name, refer to MvCameraNode for details

sValue

[IN] Camera property string to be set

Return Value

Return MV_OK(0) on success, and return Error Code on failure.

Remarks

You can call this API to set specified Enum node after connecting the device. For strKey value, refer to MvCameraNode. All the node values of "IEnumeration" in the list can be set via this API. strKey corresponds to the Name column.

The following sample code is for reference only.

#include "MvCameraControl.h"

// Wait for key input
void WaitForKeyPress(void)
{
    while(!_kbhit())
    {
        Sleep(10);
    }
    _getch();
}
bool PrintDeviceInfo(MV_CC_DEVICE_INFO* pstMVDevInfo)
{
    if (NULL == pstMVDevInfo)
    {
        printf("The Pointer of pstMVDevInfo is NULL!\n");
        return false;
    }
        if (pstMVDevInfo->nTLayerType == MV_GIGE_DEVICE)
    {
        int nIp1 = ((pstMVDevInfo->SpecialInfo.stGigEInfo.nCurrentIp & 0xff000000) >> 24);
        int nIp2 = ((pstMVDevInfo->SpecialInfo.stGigEInfo.nCurrentIp & 0x00ff0000) >> 16);
        int nIp3 = ((pstMVDevInfo->SpecialInfo.stGigEInfo.nCurrentIp & 0x0000ff00) >> 8);
        int nIp4 = (pstMVDevInfo->SpecialInfo.stGigEInfo.nCurrentIp & 0x000000ff);

        //Print the camera's IP address and user defined name
        printf("CurrentIp: %d.%d.%d.%d\n" , nIp1, nIp2, nIp3, nIp4);
        printf("UserDefinedName: %s\n\n" , pstMVDevInfo->SpecialInfo.stGigEInfo.chUserDefinedName);
    }
    else if (pstMVDevInfo->nTLayerType == MV_USB_DEVICE)
    {
        printf("UserDefinedName: %s\n", pstMVDevInfo->SpecialInfo.stUsb3VInfo.chUserDefinedName);
        printf("Serial Number: %s\n", pstMVDevInfo->SpecialInfo.stUsb3VInfo.chSerialNumber);
        printf("Device Number: %d\n\n", pstMVDevInfo->SpecialInfo.stUsb3VInfo.nDeviceNumber);
    }
    else
    {
        printf("Not support.\n");
    }
    return true;
}

void __stdcall EventCallBack(MV_EVENT_OUT_INFO * pEventInfo, void* pUser)
{
    if (pEventInfo)
    {
        __int64 nBlockId = pEventInfo->nBlockIdHigh;
        nBlockId = (nBlockId << 32) + pEventInfo->nBlockIdLow;
        __int64 nTimestamp = pEventInfo->nTimestampHigh;
        nTimestamp = (nTimestamp << 32) + pEventInfo->nTimestampLow;
        printf("EventName[%s], EventID[%u], BlockId[%I64d], Timestamp[%I64d]\n";
        pEventInfo->EventName, pEventInfo->nEventID,nBlockId,nTimestamp);
     }
}

int main()
{
    int nRet = MV_OK;
    void* handle = NULL;
    do
    {
        //Enumerate devices
        MV_CC_DEVICE_INFO_LIST stDeviceList;
        memset(&stDeviceList, 0, sizeof(MV_CC_DEVICE_INFO_LIST));
        nRet = MV_CC_EnumDevices(MV_GIGE_DEVICE | MV_USB_DEVICE, &stDeviceList);
        if (MV_OK != nRet)
        {
            printf("Enum Devices fail! nRet [0x%x]\n", nRet);
            break;
        }
        if (stDeviceList.nDeviceNum > 0)
        {
            for (unsigned int i = 0; i < stDeviceList.nDeviceNum; i++)
            {
                printf("[device %d]:\n", i);
                MV_CC_DEVICE_INFO* pDeviceInfo = stDeviceList.pDeviceInfo[i];
                if (NULL == pDeviceInfo)
                {
                    break;
                }
                 PrintDeviceInfo(pDeviceInfo);
             }
         }
         else
         {
             printf("Find No Devices!\n");
             break;
         }
         printf("Please Intput camera index:");
         unsigned int nIndex = 0;
         scanf("%d", &nIndex);
         if (nIndex >= stDeviceList.nDeviceNum)
         {
              printf("Intput error!\n");
              break;
         }
         //Select device and create handle
         nRet = MV_CC_CreateHandle(&handle, stDeviceList.pDeviceInfo[nIndex]);
         if (MV_OK != nRet)
         {
               printf("Create Handle fail! nRet [0x%x]\n", nRet);
               break;
         }
         //Open camera
         nRet = MV_CC_OpenDevice(handle);
         if (MV_OK != nRet)
         {
               printf("Open Device fail! nRet [0x%x]\n", nRet);
               break;
         }
         nRet = MV_CC_SetEnumValue(handle, "TriggerMode", MV_TRIGGER_MODE_OFF);
         if (MV_OK != nRet)
         {
               printf("Set Trigger Mode fail! nRet [0x%x]\n", nRet);
               break
         }
         //Set Event of ExposureEnd On
         nRet = MV_CC_SetEnumValueByString(handle,"EventSelector","ExposureEnd");
         if (MV_OK != nRet)
         {
               printf("Set Event Selector fail! nRet [0x%x]\n", nRet);
               break;
         }
         nRet = MV_CC_SetEnumValueByString(handle,"EventNotification","On");
         if (MV_OK != nRet)
         {
               printf("Set Event Notification fail! nRet [0x%x]\n", nRet);
               break;
         }
         //Register event callback
         nRet = MV_CC_RegisterEventCallBackEx(handle, "ExposureEnd", EventCallBack, handle);
         if (MV_OK != nRet)
         {
               printf("Register Event CallBack fail! nRet [0x%x]\n", nRet);
               break;
         }
         //Start image acquisition
         nRet = MV_CC_StartGrabbing(handle);
         if (MV_OK != nRet)
         {
               printf("Start Grabbing fail! nRet [0x%x]\n", nRet);
               break;
         }
         printf("Press a key to stop grabbing.\n");
         WaitForKeyPress();

         //Stop image acquisition
         nRet = MV_CC_StopGrabbing(handle);
         if (MV_OK != nRet)
         {
               printf("Stop Grabbing fail! nRet [0x%x]\n", nRet);
               break;
         }

         //Close camera
         nRet = MV_CC_CloseDevice(handle);
         if (MV_OK != nRet)
         {
               printf("Close Device fail! nRet [0x%x]\n", nRet);
               break;
         }
         //Destroy handle
         nRet = MV_CC_DestroyHandle(handle);
         if (MV_OK != nRet)
         {
               printf("Destroy Handle fail! nRet [0x%x]\n", nRet);
               break;
         }
         while (0);

         if (nRet != MV_OK)
         {
               if (handle != NULL)
               {
                      MV_CC_DestroyHandle(handle);
                      handle = NULL;
               }
         }
         printf("Press a key to exit.\n");
         WaitForKeyPress();
         return 0;
    }
}

MV_CC_SetEnumValueByString

Set the value of camera Enum type node.

API Definition

int MV_CC_SetEnumValueByString(
  void         *handle,
  const char   *strKey,
  const char   *sValue
);

Parameters

handle

[IN] Device handle, which is returned by MV_CC_CreateHandle or MV_CC_CreateHandleWithoutLog.

strKey

[IN] Node name, refer to MvCameraNode for details

sValue

[IN] Camera property string to be set

Return Value

Return MV_OK(0) on success, and return Error Code on failure.

Remarks

You can call this API to set specified Enum node after connecting the device. For strKey value, refer to MvCameraNode. All the node values of "IEnumeration" in the list can be set via this API. strKey corresponds to the Name column.

The following sample code is for reference only.

#include "MvCameraControl.h"

// Wait for key input
void WaitForKeyPress(void)
{
    while(!_kbhit())
    {
        Sleep(10);
    }
    _getch();
}
bool PrintDeviceInfo(MV_CC_DEVICE_INFO* pstMVDevInfo)
{
    if (NULL == pstMVDevInfo)
    {
        printf("The Pointer of pstMVDevInfo is NULL!\n");
        return false;
    }
        if (pstMVDevInfo->nTLayerType == MV_GIGE_DEVICE)
    {
        int nIp1 = ((pstMVDevInfo->SpecialInfo.stGigEInfo.nCurrentIp & 0xff000000) >> 24);
        int nIp2 = ((pstMVDevInfo->SpecialInfo.stGigEInfo.nCurrentIp & 0x00ff0000) >> 16);
        int nIp3 = ((pstMVDevInfo->SpecialInfo.stGigEInfo.nCurrentIp & 0x0000ff00) >> 8);
        int nIp4 = (pstMVDevInfo->SpecialInfo.stGigEInfo.nCurrentIp & 0x000000ff);

        //Print the camera's IP address and user defined name
        printf("CurrentIp: %d.%d.%d.%d\n" , nIp1, nIp2, nIp3, nIp4);
        printf("UserDefinedName: %s\n\n" , pstMVDevInfo->SpecialInfo.stGigEInfo.chUserDefinedName);
    }
    else if (pstMVDevInfo->nTLayerType == MV_USB_DEVICE)
    {
        printf("UserDefinedName: %s\n", pstMVDevInfo->SpecialInfo.stUsb3VInfo.chUserDefinedName);
        printf("Serial Number: %s\n", pstMVDevInfo->SpecialInfo.stUsb3VInfo.chSerialNumber);
        printf("Device Number: %d\n\n", pstMVDevInfo->SpecialInfo.stUsb3VInfo.nDeviceNumber);
    }
    else
    {
        printf("Not support.\n");
    }
    return true;
}

void __stdcall EventCallBack(MV_EVENT_OUT_INFO * pEventInfo, void* pUser)
{
    if (pEventInfo)
    {
        __int64 nBlockId = pEventInfo->nBlockIdHigh;
        nBlockId = (nBlockId << 32) + pEventInfo->nBlockIdLow;
        __int64 nTimestamp = pEventInfo->nTimestampHigh;
        nTimestamp = (nTimestamp << 32) + pEventInfo->nTimestampLow;
        printf("EventName[%s], EventID[%u], BlockId[%I64d], Timestamp[%I64d]\n";
        pEventInfo->EventName, pEventInfo->nEventID,nBlockId,nTimestamp);
     }
}

int main()
{
    int nRet = MV_OK;
    void* handle = NULL;
    do
    {
        //Enumerate devices
        MV_CC_DEVICE_INFO_LIST stDeviceList;
        memset(&stDeviceList, 0, sizeof(MV_CC_DEVICE_INFO_LIST));
        nRet = MV_CC_EnumDevices(MV_GIGE_DEVICE | MV_USB_DEVICE, &stDeviceList);
        if (MV_OK != nRet)
        {
            printf("Enum Devices fail! nRet [0x%x]\n", nRet);
            break;
        }
        if (stDeviceList.nDeviceNum > 0)
        {
            for (unsigned int i = 0; i < stDeviceList.nDeviceNum; i++)
            {
                printf("[device %d]:\n", i);
                MV_CC_DEVICE_INFO* pDeviceInfo = stDeviceList.pDeviceInfo[i];
                if (NULL == pDeviceInfo)
                {
                    break;
                }
                 PrintDeviceInfo(pDeviceInfo);
             }
         }
         else
         {
             printf("Find No Devices!\n");
             break;
         }
         printf("Please Intput camera index:");
         unsigned int nIndex = 0;
         scanf("%d", &nIndex);
         if (nIndex >= stDeviceList.nDeviceNum)
         {
              printf("Intput error!\n");
              break;
         }
         //Select device and create handle
         nRet = MV_CC_CreateHandle(&handle, stDeviceList.pDeviceInfo[nIndex]);
         if (MV_OK != nRet)
         {
               printf("Create Handle fail! nRet [0x%x]\n", nRet);
               break;
         }
         //Open camera
         nRet = MV_CC_OpenDevice(handle);
         if (MV_OK != nRet)
         {
               printf("Open Device fail! nRet [0x%x]\n", nRet);
               break;
         }
         nRet = MV_CC_SetEnumValue(handle, "TriggerMode", MV_TRIGGER_MODE_OFF);
         if (MV_OK != nRet)
         {
               printf("Set Trigger Mode fail! nRet [0x%x]\n", nRet);
               break
         }
         //Set Event of ExposureEnd On
         nRet = MV_CC_SetEnumValueByString(handle,"EventSelector","ExposureEnd");
         if (MV_OK != nRet)
         {
               printf("Set Event Selector fail! nRet [0x%x]\n", nRet);
               break;
         }
         nRet = MV_CC_SetEnumValueByString(handle,"EventNotification","On");
         if (MV_OK != nRet)
         {
               printf("Set Event Notification fail! nRet [0x%x]\n", nRet);
               break;
         }
         //Register event callback
         nRet = MV_CC_RegisterEventCallBackEx(handle, "ExposureEnd", EventCallBack, handle);
         if (MV_OK != nRet)
         {
               printf("Register Event CallBack fail! nRet [0x%x]\n", nRet);
               break;
         }
         //Start image acquisition
         nRet = MV_CC_StartGrabbing(handle);
         if (MV_OK != nRet)
         {
               printf("Start Grabbing fail! nRet [0x%x]\n", nRet);
               break;
         }
         printf("Press a key to stop grabbing.\n");
         WaitForKeyPress();

         //Stop image acquisition
         nRet = MV_CC_StopGrabbing(handle);
         if (MV_OK != nRet)
         {
               printf("Stop Grabbing fail! nRet [0x%x]\n", nRet);
               break;
         }

         //Close camera
         nRet = MV_CC_CloseDevice(handle);
         if (MV_OK != nRet)
         {
               printf("Close Device fail! nRet [0x%x]\n", nRet);
               break;
         }
         //Destroy handle
         nRet = MV_CC_DestroyHandle(handle);
         if (MV_OK != nRet)
         {
               printf("Destroy Handle fail! nRet [0x%x]\n", nRet);
               break;
         }
         while (0);

         if (nRet != MV_OK)
         {
               if (handle != NULL)
               {
                      MV_CC_DestroyHandle(handle);
                      handle = NULL;
               }
         }
         printf("Press a key to exit.\n");
         WaitForKeyPress();
         return 0;
    }
}